/**
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */
package org.apache.pinot.controller.recommender.data.writer;

import org.apache.pinot.controller.recommender.data.generator.DataGenerator;


/**
 * Interface to write data to a datasource.
 * Implementations of this interface should use {@link DataGenerator} to generate new rows
 * and write those to the respective datasource.
 */
public interface Writer {

  /**
   * Initialise the Writer
   * @param spec {@link WriterSpec} object which contains {@link DataGenerator} object
   *             used to generate rows to write to the data source
   */
  void init(WriterSpec spec);

  /**
   * Writes the generated rows to the specified datasource
   * @throws Exception
   */
  void write()
      throws Exception;

  /**
   * Cleanup the data written to the datasource
   */
  void cleanup();
}
